home *** CD-ROM | disk | FTP | other *** search
/ Creative Computers / Creative Computers CD-ROM, Volume 1 (Legendary Design Technologies, Inc.)(1994).iso / shareware / management / psx_1.3 / psx.docs < prev    next >
Text File  |  1994-11-17  |  8KB  |  214 lines
  1.  
  2.  
  3.                   PSX 1.3 (PublicScreenX)
  4.             
  5.                           A 2.0 Public Screen Manager
  6.  
  7.                    by Steve Tibbett
  8.  
  9.  
  10. ---
  11. UPDATE NOTE:  PSX 1.1 is PSX 1.0 with some enforcer hits removed, and
  12. with the addition of a DISPLAYID keyword when starting from CLI.  If
  13. you've got the CBM includes then you can specify a DisplayID as a hex
  14. number as in PSX OPEN Phred DISPLAYID 0x8000 (to get a hires screen).
  15.  
  16. Also, 1.1 changes the way the MAKEDEFAULT keyword works.  MAKEDEFAULT
  17. is now /K instead of /S, meaning it now needs a string.  So to open
  18. Phred and have it be the default, you'd need to do something like
  19. PSX OPEN PHRED MAKEDEFAULT PHRED.
  20. ---
  21.  
  22. ---
  23. UPDATE NOTE II: PSX 1.2 was bug fixes
  24. ---
  25.  
  26. ---
  27. UPDATE NOTE III: PSX 1.3 adds a number of major features to PSX.
  28. One of them is a Workbench interface - all the keywords are now
  29. valid from the Workbench.  So, you could set up PSX's icon with
  30. OPEN="Fred" as a ToolType, and when double-clicked, Fred will
  31. open.  This works for all the keywords, including the Boolean
  32. keywords (ie, POP, or SHANGHAI).
  33.  
  34. Two new keywords:  NOGUI opens PSX resident with NO graphic user
  35. interface.  HOTKEY lets you change the hotkey you'll use to call
  36. up PSX - the default is "lcommand s" or Left-Amiga-S.  
  37.  
  38. The hotkey, when active, turns PSX into a Commodity - if you 
  39. run "Exchange", you'll see PSX in the list - you can activate
  40. PSX from Exchange by clicking on it and then clicking on "Show".
  41.  
  42. If you hit ESCAPE when looking at the main window, or click on the
  43. Close gadget (instead of the Quit gadget), PSX will go into 
  44. Resident mode waiting for either the hotkey or a break signal.  The
  45. hotkey will always be Left-Amiga-S unless you explicitly change
  46. it when PSX is invoked.  (From Workbench, this would be via 
  47. HOTKEY="SHIFT f3" or whatever key you want, as a Tooltype).
  48.  
  49. If you want to make PSX resident at startup, add a DONOTWAIT
  50. tooltype and a NOGUI tooltype, and then drag PSX into your WBStartup
  51. drawer.  This way, Workbench won't wait for PSX to quit when it's 
  52. been loaded, and it will be loaded every time you reboot.
  53.  
  54. I moved a lot of the error messages from the CLI into their own
  55. requesters.  I increased the max bitplanes from 4 to 8 - the chips
  56. can only display 6, but Intuition will happily allocate 8 bitplanes
  57. anyway.  (I was testing the error handling code - tried to open 8
  58. bitplanes and it let me.  Was sure it was my code until I noticed
  59. the system thought the screen had 8 bitplanes).
  60. ---
  61.  
  62.  
  63. PSX is a utility that won't mean much to you unless you have programs that
  64. use public screens, or you need to have a public screen around to open
  65. windows on.
  66.  
  67. PSX can be run with no arguments, in which case it will open up it's
  68. user interface, or you can get it to do most of it's things from the
  69. command line.
  70.  
  71. THE USER INTERFACE
  72.  
  73. The user interface is very straightforward so I will only touch on it
  74. lightly here.  
  75.  
  76. When you run PSX with no arguments, a window will open with gadgets along
  77. the left side, and a scrolling list on the right side.  The scrolling list
  78. contains the names of all the public screens currently in the system, and
  79. the gadgets on the left are various ways of maniuplating items in the list.
  80.  
  81. To select a screen, simply click on it's name.  The name of the last 
  82. selected screen is just below the list.  
  83.  
  84. "Open Screen" will pop up another window with screen selection gadgets -
  85. type in the name you want for your new screen, if you want it to be
  86. hires, etc., click on the appropriate gadgets, then click Open Screen
  87. (or Cancel if you get cold feet).
  88.  
  89. "Close Screen" will attempt to close the screen.  Public Screens are 
  90. supposed to be closed by the program that owns them, so this is usually
  91. only a good idea to perform on screens you have opened with "Open Screen".
  92.  
  93. "Move To Screen" will move the PSX window itself to the selected
  94. screen.  If the screen is LORES, PSX may have a hard time squeezing
  95. itself onto the screen, but otherwise it should have no trouble dealing
  96. with whatever fonts and colours the screen has up.
  97.  
  98. "Make Default" will make the selected screen the "Default Public Screen" -
  99. which simply means that any program smart enough to open on the 
  100. "Default Public Screen" will now open on that ascreen.
  101.  
  102. "Refresh List" just grabs a new copy of the screen list, since it won't
  103. automatically notice if a screen appears or disappears while the
  104. window is open.
  105.  
  106. The next two gadgets are "Global Flags" that affect the operation of all
  107. public screens.  The "Shanghai" flag, when on, will redirect all windows that
  108. would have gone to the "Workbench" screen to the "Default Public Screen",
  109. and the "PopPubScreen" flag will bring to the front any public screen as
  110. a window opens on it.
  111.  
  112. THE COMMAND LINE
  113.  
  114. Typing "PSX ?" will give you this:
  115.  
  116. OPEN/K,CLOSE/K,DISPLAYID/K,HIRES/S,LACE/S,DEPTH/N,MAKEDEFAULT/K,SHANGHAI/S,
  117. NOSHANGHAI/S,POP/S,NOPOP/S,TOFRONT/K,TOBACK/K
  118.  
  119. and in that line is everything you need to know about PSX's command line
  120. interface. The keywords are:
  121.     
  122.     OPEN "ScreenName"
  123.     CLOSE "ScreenName"
  124.     DISPLAYID 0x00000000 (display ID number, 0x#=Hex, otherwise Decimal)
  125.     SHANGHAI
  126.     NOSHANGHAI
  127.     POP
  128.     NOPOP
  129.     TOFRONT "ScreenName"
  130.     TOBACK "ScreenName"
  131.     MAKEDEFAULT "ScreenName"
  132.  
  133. The HIRES and DEPTH items are flags for the OPEN command (ie, 
  134. OPEN "ScreenName" HIRES LACE will open a hires interlaced screen.  The
  135. depth is specified as DEPTH 3 where 3 is the number of bitplanes the
  136. screen is to have.  MAKEDEFAULT specifies that the newly opened screen
  137. should also become the Default Public Screen.
  138.  
  139. SHANGHAI and NOSHANGHAI turn the Shanghai flag on and off.  These get
  140. processed AFTER the "Open" and "Close" commands.
  141.  
  142. POP and NOPOP turn on and off the POPPUBSCREEN flag - enable and disable
  143. the popping to the front of any screen whenever a window is opened.
  144.  
  145. So a valid command line would be:
  146.  
  147.       PSX OPEN "CLIScreen" HIRES LACE DEPTH 1 MAKEDEFAULT "CLIScreen" 
  148.     SHANGHAI POP
  149.  
  150. which would give you a screen entitled "CLIScreen", Hires interlaced,
  151. (with the actual dimensions taken from your preferences), and the SHANGHAI
  152. and POPPUBSCREEN flags are both turned on.
  153.  
  154. This in combination with the fact that under 2.0 you can give a Public
  155. Screen name for console windows to open up on means you can set up a 
  156. screen for the exclusive purpose of running a CLI or two on, making them
  157. one bitplane so they scroll more quickly than the Workbench screen,
  158. which would look kind of ugly in one bitplane.
  159.  
  160. Remember that all public screen names ARE case sensitive - "MyScreen" is 
  161. not the same as "MYSCREEN".
  162.  
  163. THE SOURCE
  164.  
  165. I've included the source to PSX.  It's a very "2.0" program - it uses
  166. the DOS "ReadArgs" call to parse the command line, it uses GadTools for
  167. the user interface, and (I believe) is a good example for dealing with
  168. public screens.
  169.  
  170. It compiles with the Lattice 5.10 C compiler and the 2.0 includes.  It
  171. will probably only compile with Lattice, as I've taken a liking to the 
  172. C++ comment style, which Lattice permits.
  173.  
  174.  
  175. AUTHOR AND DISTRIBUTION INFORMATION
  176.  
  177. PSX is freely redistributable, but is also Copyright 1990 Steve Tibbett.
  178. Distribution is only very slightly limited:  You may not distribute 
  179. PSX without it's current documentation, nor without source, 
  180. and if it is to be commercially distributed, I won't demand but I would
  181. appreciate being sent a copy of whatever it is being distributed with
  182. or on (in the case of disk magazines).
  183.  
  184. Like all my stuff, PSX will likely continue to change.  If you like
  185. PSX, check with wherever you got it every few months for updated
  186. versions, especially if you have problems with it (and have let me
  187. know about them), as I normally fix problems quickly.
  188.  
  189. I don't ask for any cash contribution for PSX.  If you are feeling
  190. guilty and just want to send something, send an original game or
  191. a neat demo, I'll probably appreciate it more than cash.
  192.  
  193.  
  194. My Virutal Addresses:
  195.  
  196.     My BBS is 613-731-3419, up 24 hours/day running my own BBS (BBX)...
  197.     You can reach me on Plink (where I'm an Asst. Chair) as STEVEX...
  198.     You can reach me on Bix as "s.tibbett"...
  199.     You can reach me through FidoNet on point 1:163/109.42...
  200.     You can send me Usenet mail at cognos!alzabo!omx!stevex...
  201.     Or you can call me at 613-731-5316.
  202.  
  203.     I prefer talking with people electronic